﻿namespace BM.Tools.WebControls.MForm.Controls.Additions
{
    /// <summary>
    /// A control that is a definition for a value of a different item that is part of the description
    /// </summary>
    public class ValueDescription : DescriptionChunk
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ValueDescription"/> class. 
        /// </summary>
        public ValueDescription()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValueDescription"/> class. 
        /// </summary>
        /// <param name="path">
        /// The path to the item.
        /// </param>
        public ValueDescription(string path)
        {
            Path = path;
        }

        /// <summary>
        /// Gets or sets Path.
        /// </summary>        
        public string Path
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the custom description method that will be performed on the selected item.
        /// </summary>
        public string CustomDescriptionMethod
        {
            get; 
            set;
        }

        /// <summary>
        /// Gets the description chunk class name
        /// </summary>
        public override string ClassName
        {
            get
            {
                return "BM.ValueDescription";
            }
        }
    }
}